Swagbadge2021 UpdatingSoftware - Revision history

Nicola at 06:28, 29 December 2021

2021-12-29T06:28:05Z

← Older revision		Revision as of 06:28, 29 December 2021
Line 20:		Line 20:
	If you choose to wipe your board and start again to ensure you know exactly what's on there, you can do so. Instructions for performing a [[Swagbadge_Reinstall\|complete reinstall]] are provided here.		If you choose to wipe your board and start again to ensure you know exactly what's on there, you can do so. Instructions for performing a [[Swagbadge_Reinstall\|complete reinstall]] are provided here.

	== Windows 10: connecting to the badge ==		== Connecting to the badge ==

			=== Windows 10: connecting to the badge ===

	How to find your serial COM port on Windows:		How to find your serial COM port on Windows:
Line 34:		Line 36:
	By this point, you have know the serial COM port that your #swagbadge is connected to, e.g COM4		By this point, you have know the serial COM port that your #swagbadge is connected to, e.g COM4

	== Mac OS: connecting the badge ==		=== Mac OS: connecting the badge ===

	How to find your serial COM port on OS X:		How to find your serial COM port on OS X:
Line 61:		Line 63:
	{{Note\|Mac users beware: If you Ctrl-C mpfshell, (or disconnect USB cable while the badge connected to mpfshell), you could crash your desktop, due to the poor kernel drivers the Lolin32 Lite uses.}}		{{Note\|Mac users beware: If you Ctrl-C mpfshell, (or disconnect USB cable while the badge connected to mpfshell), you could crash your desktop, due to the poor kernel drivers the Lolin32 Lite uses.}}

	== Linux: connecting to the badge ==		=== Linux: connecting to the badge ===

	# install the virtualwrapper https://virtualenvwrapper.readthedocs.io/en/latest/install.html		# install the virtualwrapper https://virtualenvwrapper.readthedocs.io/en/latest/install.html
Line 101:		Line 103:
	* <code>cd aiko_engine_mp</code>		* <code>cd aiko_engine_mp</code>

	~~Test that your machine can talk to the badge using mpfshell~~
	* <code>mpfshell -o COM3</code> # Adjust port to suit
	* If it has made a connection to your badge, you will see it say
	~~<nowiki>Connected to esp32~~
	~~ Micropython File Shell v0.9.1, sw@kaltpost.de ~~
	~~-- Running on Python 3.8 using PySerial 3.4 --~~
	~~mpfs [/]> </nowiki>~~

	== Using mpfshell ==		== Communicating with the badge ==

			=== Using mpfshell to communicate ===

	mpfshell has two functions: it lets you put files on/off the device, and it can give you a python shell to execute code on the device.		mpfshell has two functions: it lets you put files on/off the device, and it can give you a python shell to execute code on the device.
Line 121:		Line 118:

	Note: To get out of repl, use Ctrl-Q (on Windows) which drops you back into mpfshell		Note: To get out of repl, use Ctrl-Q (on Windows) which drops you back into mpfshell

			Test that your machine can talk to the badge using mpfshell
			* <code>mpfshell -o COM3</code> # Adjust port to suit
			* If it has made a connection to your badge, you will see it say
			<nowiki>Connected to esp32
			Micropython File Shell v0.9.1, sw@kaltpost.de
			-- Running on Python 3.8 using PySerial 3.4 --
			mpfs [/]> </nowiki>

	A little program to say hello world!		A little program to say hello world!
Line 132:		Line 137:
	>>> pin22.value(1)</nowiki>		>>> pin22.value(1)</nowiki>

	== ~~Alternatives to mpfshell:~~ Thonny, rshell ~~and~~ pyboard.py ==		=== Thonny, rshell or pyboard.py to communicate ===

	[https://thonny.org Thonny] is an IDE for python, with micropython support.		[https://thonny.org Thonny] is a (fabulous) IDE for python, with micropython support.

	rshell is an option, but it may not be reliable in all cases. However 'pip install rshell' also installs pyboard.		rshell is an option, but it may not be reliable in all cases. However 'pip install rshell' also installs pyboard.
Line 147:		Line 152:
	== Saving your private key ==		== Saving your private key ==

	~~Use mpfshell to get~~ the file: `configuration/keys.db`.		Get the file: `configuration/keys.db` from the badge to your computer, via mpfshell, Thonny, or your other chosen mechanism.

	== Putting the Aiko framework onto the device, using mpfshell ==		== Putting the Aiko framework onto the device, using mpfshell ==
	* <code>mpfshell COM5 -s scripts\aiko.mpf</code> #run from within the aiko_framework_mp directory		* <code>mpfshell COM5 -s scripts\aiko.mpf</code> #run from within the aiko_framework_mp directory

	~~=== Windows only: Patch mpfshell ===~~

	~~''Note!'' mpfshell used to need a patch applied to let it run a script under Windows. This is no longer required, but recorded here for archival purposes.~~

	* Inside <code>C:/users/USERNAME/Miniconda2/envs/swagbadge/Lib/site-packages/mp</code>
	* edit <code>mpfshell.py</code>
	* Search for <code>elif args.script is not None:</code>, around line 796
	* between that line and the next, insert two lines. It should look like:
	~~<nowiki>~~
	~~elif args.script is not None:~~

	~~if platform.system() == "Windows": #INSERT THIS LINE~~
	~~mpfs.use_rawinput = True #INSERT THIS LINE~~

	~~f = open(args.script, "r")~~
	~~</nowiki>~~
	* Python is very particular about spacing. The rest of the code uses 4 spaces for indents so follow suit.

	= Software development =		= Software development =

	See [[Swagbadge2021_SoftwareDev]]		See [[Swagbadge2021_SoftwareDev]]

Nicola: /* Download #swagbadge (Aiko Engine) firmware */

2021-12-29T06:22:31Z

Download #swagbadge (Aiko Engine) firmware

← Older revision		Revision as of 06:22, 29 December 2021
Line 92:		Line 92:
	*** <code>exit</code> # To exit mpfshell		*** <code>exit</code> # To exit mpfshell

	== Download ~~#swagbadge~~ (Aiko Engine) firmware ==		== Download Swagbadge (Aiko Engine) firmware ==

	Within your Anaconda Prompt session, change directory to where you’d like the ~~#swagbadge~~ software to live, for example:		Within your Anaconda Prompt session, change directory to where you’d like the Swagbadge software to live, for example:
	* <code>cd $HOME/software</code>		* <code>cd $HOME/software</code>

	Download ~~#swagbadge~~ firmware for a local copy of what's on the badge:		Download Swagbadge firmware for a local copy of what's on the badge:
	* <code>git clone https://github.com/geekscape/aiko_engine_mp.git</code>		* <code>git clone https://github.com/geekscape/aiko_engine_mp.git</code>
	* <code>cd aiko_engine_mp</code>		* <code>cd aiko_engine_mp</code>

Nicola: /* Starting from scratch */

2021-12-29T06:21:00Z

Starting from scratch

← Older revision		Revision as of 06:21, 29 December 2021
Line 14:		Line 14:
	** GUI instead of command line.		** GUI instead of command line.

	== Starting from scratch ==		== Starting from scratch: Optional ==

	All Swagbadges come with the operating system, basic firmware and aiko preinstalled (this is how you get your assigned encryption key). If you ~~would like~~ to wipe your board and start again to ensure you know exactly what's on there, you can do so. Instructions for performing a [[Swagbadge_Reinstall\|complete reinstall]] are provided here.		All Swagbadges come with the operating system, basic firmware and aiko preinstalled (this is how you get your assigned encryption key).

			If you choose to wipe your board and start again to ensure you know exactly what's on there, you can do so. Instructions for performing a [[Swagbadge_Reinstall\|complete reinstall]] are provided here.

	== Windows 10: connecting to the badge ==		== Windows 10: connecting to the badge ==

Nicola at 07:25, 19 December 2021

2021-12-19T07:25:01Z

← Older revision		Revision as of 07:25, 19 December 2021
Line 1:		Line 1:
	= ~~Updating the software framework~~ =		= Setting up your development environment =

	If you're doing software development, you need an environment on your computer to let you do that.		If you're doing software development, you need an environment on your computer to let you do that.


	== Requirements ==		== Requirements ==
Line 10:		Line 9:
	* Linux (including WSL), Mac OS or Windows system running Python 3		* Linux (including WSL), Mac OS or Windows system running Python 3
	* Command line tools: git		* Command line tools: git
	* Optional, but very useful: [https://thonny.org/ Thonny] - Python IDE with micropython support		* Optional, but very useful: [https://thonny.org/ Thonny] - Python IDE with micropython support. Multiplatform support.
	** Edit files directly on the badge		** Edit files directly on the badge
	** Run files directly on the badge		** Run files directly on the badge

Nicola at 07:24, 19 December 2021

2021-12-19T07:24:22Z

← Older revision		Revision as of 07:24, 19 December 2021
Line 19:		Line 19:
	All Swagbadges come with the operating system, basic firmware and aiko preinstalled (this is how you get your assigned encryption key). If you would like to wipe your board and start again to ensure you know exactly what's on there, you can do so. Instructions for performing a [[Swagbadge_Reinstall\|complete reinstall]] are provided here.		All Swagbadges come with the operating system, basic firmware and aiko preinstalled (this is how you get your assigned encryption key). If you would like to wipe your board and start again to ensure you know exactly what's on there, you can do so. Instructions for performing a [[Swagbadge_Reinstall\|complete reinstall]] are provided here.

	== ~~Setting up your~~ Windows 10 ~~system for~~ connecting to badge ~~hardware~~ ==		== Windows 10: connecting to the badge ==

	How to find your serial COM port on Windows:		How to find your serial COM port on Windows:
Line 33:		Line 33:
	By this point, you have know the serial COM port that your #swagbadge is connected to, e.g COM4		By this point, you have know the serial COM port that your #swagbadge is connected to, e.g COM4

	== ~~Setting up your~~ Mac OS ~~system for~~ connecting ~~to #swagbadge hardware~~ ==		== Mac OS: connecting the badge ==


	How to find your serial COM port on OS X:		How to find your serial COM port on OS X:
Line 61:		Line 60:
	{{Note\|Mac users beware: If you Ctrl-C mpfshell, (or disconnect USB cable while the badge connected to mpfshell), you could crash your desktop, due to the poor kernel drivers the Lolin32 Lite uses.}}		{{Note\|Mac users beware: If you Ctrl-C mpfshell, (or disconnect USB cable while the badge connected to mpfshell), you could crash your desktop, due to the poor kernel drivers the Lolin32 Lite uses.}}

	== ~~Setting up your~~ Linux ~~system for~~ connecting to ~~#swagbadge hardware~~ ==		== Linux: connecting to the badge ==

	# install the virtualwrapper https://virtualenvwrapper.readthedocs.io/en/latest/install.html		# install the virtualwrapper https://virtualenvwrapper.readthedocs.io/en/latest/install.html
Line 75:		Line 74:
	# Run <code>./scripts/flash_micropython.sh</code>		# Run <code>./scripts/flash_micropython.sh</code>

	== ~~Setting up your~~ Windows 10 ~~system~~ for ~~installing #swagbadge firmware~~ ==		== Windows 10: install utilities for commandline ==

	* Install [https://docs.conda.io/en/latest/miniconda.html Miniconda3] to create a specific Python development environment. (Note we are using Python3 not Python2)		* Install [https://docs.conda.io/en/latest/miniconda.html Miniconda3] to create a specific Python development environment. (Note we are using Python3 not Python2)
Line 94:		Line 93:
	== Download #swagbadge (Aiko Engine) firmware ==		== Download #swagbadge (Aiko Engine) firmware ==

	Within your Anaconda Prompt session, change directory to where you’d like the #swagbadge software to ~~be downloaded~~, for example:		Within your Anaconda Prompt session, change directory to where you’d like the #swagbadge software to live, for example:
	* <code>cd $HOME/software</code>		* <code>cd $HOME/software</code>

	Download #swagbadge firmware:		Download #swagbadge firmware for a local copy of what's on the badge:
	* <code>git clone https://github.com/geekscape/aiko_engine_mp.git</code> ~~# NOTE: this URL will change once we're live~~		* <code>git clone https://github.com/geekscape/aiko_engine_mp.git</code>
	* <code>cd aiko_engine_mp</code>		* <code>cd aiko_engine_mp</code>

	~~Install MicroPython~~		Test that your machine can talk to the badge using mpfshell
	* Create a directory to hold the MicroPython firmware, such as aiko_engine_mp/firmware/
	* <code>mkdir firmware</code>
	* Using your web browser, download: [http://micropython.org/resources/firmware/esp32-idf4-20200902-v1.13.bin esp32-idf4-20200902-v1.13.bin] (mouse right button click → [Save As …] saving the MicroPython firmware in the firmware directory you just made.
	** The [http://micropython.org/download/ MicroPython download list] has a link to ~~a bunch of firmware drivers, we are using~~ the ~~one for the esp32 device, with the latest 1.4 generic~~

	~~{{Note\|'''STOP'''! Make a copy of your~~ badge~~'s encryption key and network settings before proceeding. Use mpfshell to get configuration/net.py and configuration/keys.db}}~~

	~~Erase #swagbadge LoLin-Lite ESP32 flash memory~~
	* <code>esptool --chip esp32 --port COM3 erase_flash</code> # adjust the port to suit.
	* You’ll know it’s worked, if the output finishes with “Hard resetting via RTS pin…”

	~~You may get this error, if so, try esptool.py instead:~~
	~~<pre>~~
	~~sauron [mc]$ esptool --chip esp32 --port /dev/ttyUSB0 erase_flash~~
	~~esptool.py v2.8~~
	~~Serial port /dev/ttyUSB0~~
	~~Connecting....~~
	~~Chip is ESP32D0WDQ6 (revision 1)~~
	~~Features: WiFi, BT, Dual Core, 240MHz, VRef calibration in efuse, Coding Scheme None~~
	~~Crystal is 40MHz~~
	~~MAC: 7c:9e:bd:ed:79:24~~
	~~Enabling default SPI flash mode...~~
	~~Erasing flash (this may take a while)...~~

	~~A fatal error occurred: ESP32 ROM does not support function erase_flash.~~
	~~sauron [mc]$ esptool.py --chip esp32 --port /dev/ttyUSB0 erase_flash~~
	~~esptool.py v2.6~~
	~~Serial port /dev/ttyUSB0~~
	~~Connecting....~~
	~~Chip is ESP32D0WDQ6 (revision 1)~~
	~~Features: WiFi, BT, Dual Core, 240MHz, VRef calibration in efuse, Coding Scheme None~~
	~~MAC: 7c:9e:bd:ed:79:24~~
	~~Uploading stub...~~
	~~Running stub...~~
	~~Stub running...~~
	~~Erasing flash (this may take a while)...~~
	~~Chip erase completed successfully in 11.8s~~
	~~Hard resetting via RTS pin...~~
	~~</pre>~~


	~~Install microPython on the badge~~
	* <code>esptool --chip esp32 --port COM3 --baud 460800 write_flash -z 0x1000 firmware\esp32-idf4-20200902-v1.13.bin</code> #adjust port and firmware location if necessary
	* You’ll know it’s worked, if the output finishes with “Hard resetting via RTS pin…”

	~~Test that the software is installed correctly by~~ using mpfshell
	* <code>mpfshell -o COM3</code> # Adjust port to suit		* <code>mpfshell -o COM3</code> # Adjust port to suit
	* If it has made a connection to your badge, you will see it say		* If it has made a connection to your badge, you will see it say
Line 180:		Line 133:
	== Alternatives to mpfshell: Thonny, rshell and pyboard.py ==		== Alternatives to mpfshell: Thonny, rshell and pyboard.py ==

	Thonny is an IDE for python, with micropython support.		[https://thonny.org Thonny] is an IDE for python, with micropython support.

	rshell is an option, but it may not be reliable in all cases. However 'pip install rshell' also installs pyboard.		rshell is an option, but it may not be reliable in all cases. However 'pip install rshell' also installs pyboard.

Nicola at 07:07, 19 December 2021

2021-12-19T07:07:34Z

← Older revision		Revision as of 07:07, 19 December 2021
Line 1:		Line 1:
	= Updating the software framework =		= Updating the software framework =

	~~Swagbadge owners might want to update the~~ software ~~framework (Aiko). Dagbadge owners will~~ need to ~~put the framework onto their badge before they can use it~~.		If you're doing software development, you need an environment on your computer to let you do that.

	~~Here's how to do that!~~

	== Requirements ==		== Requirements ==
Line 15:		Line 14:
	** Run files directly on the badge		** Run files directly on the badge
	** GUI instead of command line.		** GUI instead of command line.

			== Starting from scratch ==

			All Swagbadges come with the operating system, basic firmware and aiko preinstalled (this is how you get your assigned encryption key). If you would like to wipe your board and start again to ensure you know exactly what's on there, you can do so. Instructions for performing a [[Swagbadge_Reinstall\|complete reinstall]] are provided here.

	== Setting up your Windows 10 system for connecting to badge hardware ==		== Setting up your Windows 10 system for connecting to badge hardware ==

Nicola: /* Putting the Aiko framework onto the device, using mpfshell */

2021-12-19T07:02:22Z

Putting the Aiko framework onto the device, using mpfshell

← Older revision		Revision as of 07:02, 19 December 2021
Line 197:		Line 197:
	=== Windows only: Patch mpfshell ===		=== Windows only: Patch mpfshell ===

	''Note!'' mpfshell ~~needs~~ a patch applied to let it run a script under Windows. ~~(the patch~~ is ~~included upstream~~, ~~it's just not in a released distribution yet)~~		''Note!'' mpfshell used to need a patch applied to let it run a script under Windows. This is no longer required, but recorded here for archival purposes.

	* Inside <code>C:/users/USERNAME/Miniconda2/envs/swagbadge/Lib/site-packages/mp</code>		* Inside <code>C:/users/USERNAME/Miniconda2/envs/swagbadge/Lib/site-packages/mp</code>

Nicola: /* Alternatives to mpfshell: rshell and pyboard.py */

2021-12-19T07:01:08Z

Alternatives to mpfshell: rshell and pyboard.py

← Older revision		Revision as of 07:01, 19 December 2021
Line 175:		Line 175:
	>>> pin22.value(1)</nowiki>		>>> pin22.value(1)</nowiki>

	== Alternatives to mpfshell: rshell and pyboard.py ==		== Alternatives to mpfshell: Thonny, rshell and pyboard.py ==

			Thonny is an IDE for python, with micropython support.

	rshell is an option, but it may not be reliable in all cases. However 'pip install rshell' also installs pyboard.		rshell is an option, but it may not be reliable in all cases. However 'pip install rshell' also installs pyboard.

Nicola: /* Requirements */

2021-12-19T06:59:05Z

Requirements

← Older revision		Revision as of 06:59, 19 December 2021
Line 9:		Line 9:
	* #swagbadge or #dagbadge or any ESP32 with an OLED screen		* #swagbadge or #dagbadge or any ESP32 with an OLED screen
	* Micro-USB cable		* Micro-USB cable
	* Linux, Mac OS or ~~Linux~~ system running Python 3		* Linux (including WSL), Mac OS or Windows system running Python 3
	* Command line tools: git		* Command line tools: git
			* Optional, but very useful: [https://thonny.org/ Thonny] - Python IDE with micropython support
			** Edit files directly on the badge
			** Run files directly on the badge
			** GUI instead of command line.

	== Setting up your Windows 10 system for connecting to badge hardware ==		== Setting up your Windows 10 system for connecting to badge hardware ==

Nicola: /* Setting up your Linux system for connecting to #swagbadge hardware */

2021-01-24T04:50:22Z

Setting up your Linux system for connecting to #swagbadge hardware

← Older revision		Revision as of 04:50, 24 January 2021
Line 55:		Line 55:

	== Setting up your Linux system for connecting to #swagbadge hardware ==		== Setting up your Linux system for connecting to #swagbadge hardware ==
	~~[Link other instructions here]~~
			# install the virtualwrapper https://virtualenvwrapper.readthedocs.io/en/latest/install.html
			# Add the below code to your .bashrc
			export WORKON_HOME=$HOME/.virtualenvs
			export VIRTUALENVWRAPPER_PYTHON=/usr/bin/python3
			export VIRTUALENVWRAPPER_VIRTUALENV=/usr/bin/virtualenv
			export PROJECT_HOME=$HOME/Programming
			source /usr/local/bin/virtualenvwrapper.sh
			export AMPY_PORT=ttyUSB0 # note: no leading /dev/
			# Create a firmware folder
			# Download the bin file per listed above!
			# Run <code>./scripts/flash_micropython.sh</code>

	== Setting up your Windows 10 system for installing #swagbadge firmware ==		== Setting up your Windows 10 system for installing #swagbadge firmware ==