Swagbadge2021 SoftwareDev - Revision history

Nicola: /* Hardware reference */

2021-01-25T05:11:08Z

Hardware reference

← Older revision		Revision as of 05:11, 25 January 2021
Line 211:		Line 211:
	Globals		Globals
	* '''[] oled.oleds''' # an array of oleds, letting you address them separately if you choose		* '''[] oled.oleds''' # an array of oleds, letting you address them separately if you choose
	* '''int oled.fg/oled.bg''' # get/set fg and bg colours (0 or 1)		* '''int oled.FG/oled.BG''' # get/set fg and bg colours (0 or 1)
	* '''int oled.font_size''' # helpful to work out how much space a line of text will take up		* '''int oled.font_size''' # helpful to work out how much space a line of text will take up
	* '''boolean oled.lock_title''' # true/false. True means the display always shows the title. False means it'll be wiped once the display is cleared.		* '''boolean oled.lock_title''' # true/false. True means the display always shows the title. False means it'll be wiped once the display is cleared. Annunciators always are displayed.

	Functions		Functions
	* '''oled.initialise()''' # uses configuration.oled.settings by default, normally already invoked by the base swagbadge handler		* '''oled.initialise()''' # uses configuration.oled.settings by default, normally already invoked by the base swagbadge handler
	* '''oled.oleds_clear(colour)''' # pass in oled.bg or oled.fg for easy set. Wipes the display		* '''oled.oleds_clear(colour)''' # pass in oled.BG or oled.FG for easy set. Wipes the display
	* '''oled.log(text)''' # scroll up text to insert a new line at the bottom of the display		* '''oled.log(text)''' # scroll up text to insert a new line at the bottom of the display
	* '''oled.text(text, x, y, colour)''' # add text at the position x,y in the colour specified. Note: does not clear the contents at this spot first.		* '''oled.text(text, x, y, colour)''' # add text at the position x,y in the colour specified. Note: does not clear the contents at this spot first.
Line 238:		Line 238:
	=== Screen buttons ===		=== Screen buttons ===

	If you push (gently!) on the screens, you'll discover they double as buttons: there's a small switch under each OLED that is pressed when you push down on the screen.		If you push (firmly but gently) on the screens, you'll discover they double as buttons: there's a small switch under each OLED that is pressed when you push down on the screen.

	{{Note\|'''Warning''': Push on the '''middle''' of the screen, not the edge. This will minimise the risk of bending... and breaking... the screen.}}		{{Note\|'''Warning''': Push on the '''middle''' of the screen, not the edge. This will minimise the risk of bending... and breaking... the screen.}}
Line 247:		Line 247:

	<pre>		<pre>
	from ~~machine~~ import ~~Pin~~		from aiko import button

	~~button_left~~ = ~~Pin(~~16~~, Pin.IN, Pin.PULL_UP)~~		left_screen = 16
	~~button_right~~ = ~~Pin(~~17~~, Pin.IN, Pin.PULL_UP)~~		right_screen = 17

	~~pressed = not~~(~~button_left~~.~~value~~())		def my_button_handler(number, state):
			print("Button {}: {}".format(number, "press" if state else "release"))

			button.add_button_handler(my_button_handler, [left_screen, right_screen])
			aiko.button.add_touch_handler(my_button_handler, [12, 14, 15, 27])
			aiko.button.remove_handler(my_button_handler)


			def my_multibutton_handler(pin_numbers):
			print("Multibutton {}".format(pin_numbers))
			button.add_multibutton_handler(my_multibutton_handler, [12, 14])
			button.add_multibutton_handler(my_multibutton_handler, [15, 27])
			button.remove_handler(my_multibutton_handler)
	</pre>		</pre>

	~~The button sends "1" when it's ''not'' being pressed, and "0" when it is. This is counterintuitive to most of us, so I recommend inverting the value when reading it.~~

	=== Sliders ===		=== Sliders ===
Line 266:		Line 276:

	<pre>		<pre>
	~~from machine~~ import ~~Pin, TouchPad~~		import aiko.button as button
	import aiko.common		import aiko.common as common

			bottom_left = 12
			top_left = 15
			bottom_right = 14
			top_right = 27

			def my_slider_handler(number, state, value):
			print("Slider {}: {} {}".format(number, state, value))
			# use the map handler to give you the slider values mapped from its min-max to yours
			mapped_value = int(common.map_value(value, 0, 100, 1, 5))

			aiko.button.add_slider_handler(my_slider_handler, bottom_left, top_left)
			aiko.button.add_slider_handler(my_slider_handler, bottom_right, top_right)
			aiko.button.remove_handler(my_slider_handler)

	~~bottom_left = TouchPad(Pin(12))~~
	~~top_left = TouchPad(Pin(15))~~
	~~bottom_right = TouchPad(Pin(14))~~
	~~top_right = TouchPad(Pin(27))~~

	# is this button pressed?		# is this button pressed?
	# the commons library returns true/false		# the commons library returns true/false
	pressed_bottom_left = common.touch_pins_check([bottom_left])		pressed_bottom_left = common.touch_pins_check([bottom_left])

	~~# check where we are along the slider~~
	~~# the 'read' functions return an integer of the 'strength' of the~~
	~~# capacitance. As you move your finger between the endpoints,~~
	~~#the relative value of the difference between them will change.~~
	~~slider_left = bottom_left.read() - bottom_left.read()~~
	</pre>		</pre>

	Micropython functions		Micropython functions
	* '''touchpad.read()''' - gives you the current value of the sensor. It will be large when not touched (over 1000) and smaller when touched.
	~~Aiko functions~~
	* '''common.touch_pins_check(touchpad_array)''' - Returns true if ''all'' the touchpad sensors listed are being touched, false otherwise.		* '''common.touch_pins_check(touchpad_array)''' - Returns true if ''all'' the touchpad sensors listed are being touched, false otherwise.
			* '''common.map_value(input, in_min, in_max, out_min, out_max)''': map an input range to an output range and convert the input value to a value in the output range.

	=== SAOs (simple addons) ===		=== SAOs (simple addons) ===

	Information about [[Swagbadge2021_SAO\|hardware]]		Information about [[Swagbadge2021_SAO\|hardware]]

AndyGelme: /* Directory structure */

2021-01-25T04:05:01Z

Directory structure

← Older revision		Revision as of 04:05, 25 January 2021
Line 110:		Line 110:
	* <code>lib</code> - code in here is aiko framework code and automatically in the micropython 'path'.		* <code>lib</code> - code in here is aiko framework code and automatically in the micropython 'path'.
	** <code>aiko</code> - the aiko framework		** <code>aiko</code> - the aiko framework
	* <code>applications</code> - programs to run automatically on bootup. ~~Must~~ have an initialise function		* <code>applications</code> - collection of programs, one of which is configured to run automatically on bootup. Each application must have an initialise() function
	* <code>configuration</code> - control the ~~config~~ of ~~aiko using files in here~~		* <code>configuration</code> - control the behavior of Aiko by changing the "settings", e.g configuration/main.py specifies which application to run
	* <code>examples</code> - sample code!		* <code>examples</code> - sample code!

Line 122:		Line 122:

	Because the aiko configuration files are, themselves, just python, you can also do <code>import configuration.main.settings</code> where the file is in /configuration/main.py but it contains a datastructure called 'settings'.		Because the aiko configuration files are, themselves, just python, you can also do <code>import configuration.main.settings</code> where the file is in /configuration/main.py but it contains a datastructure called 'settings'.

	=== MQTT ===		=== MQTT ===

Nicola: /* SAOs (simple addons) */

2021-01-23T23:51:53Z

SAOs (simple addons)

← Older revision		Revision as of 23:51, 23 January 2021
Line 290:		Line 290:

	=== SAOs (simple addons) ===		=== SAOs (simple addons) ===

			Information about [[Swagbadge2021_SAO\|hardware]]

Marcmerlin: /* OLED screens */

2021-01-17T23:03:19Z

OLED screens

← Older revision		Revision as of 23:03, 17 January 2021
Line 223:		Line 223:
	* '''oled.write_title()''' # write the title text		* '''oled.write_title()''' # write the title text

	~~Coming soon~~ - a ~~way~~ to ~~easily write images~~ to an oled.		==== Oled image push and I2C speed ====

			- example #1: https://github.com/geekscape/aiko_engine_mp/blob/master/examples/oled_image.py

			- example #2: https://github.com/geekscape/aiko_engine_mp/blob/master/examples/oled_benchmark.py

			The 2nd example gets a speed of 21fps per screen (or about 10fps for both screens).

			Using C++ code (see https://github.com/geekscape/aiko_engine_mp/commit/a22b3099584c9978807e08adf752f3082af65875 ) you get at least 61fps per screen (if you do assembly: 86fps, and with crazy I2C noacks hacks, you can get 150fps: https://bitbanksoftware.blogspot.com/2018/05/fast-ssd1306-oled-drawing-with-i2c-bit.html ).

			Back to python, if you increase the CPU speed with machine.freq(240000000) , you'll get 26fps per screen, and if you replace the image pixel pushes by a full back or full white push, you get 29fps, which seems to be an upper limit of the python oled code. A better end to end C++ driver could give a lot more speed.

	=== Screen buttons ===		=== Screen buttons ===

Marcmerlin at 01:06, 17 January 2021

2021-01-17T01:06:44Z

← Older revision		Revision as of 01:06, 17 January 2021
Line 88:		Line 88:

	{{Note\|Note: Refreshing the OLEDs is reasonably intense on the microprocessor. If you have too many event loops triggering too often and/or too much screen activity, you can starve the badge of resources. This can produce wifi dropouts, or non-responsiveness. If you have a lot of screen activity, consider using a buffer or recording state and just doing a screen update periodically}}		{{Note\|Note: Refreshing the OLEDs is reasonably intense on the microprocessor. If you have too many event loops triggering too often and/or too much screen activity, you can starve the badge of resources. This can produce wifi dropouts, or non-responsiveness. If you have a lot of screen activity, consider using a buffer or recording state and just doing a screen update periodically}}


	== Software reference ==		== Software reference ==
Line 121:		Line 122:

	Because the aiko configuration files are, themselves, just python, you can also do <code>import configuration.main.settings</code> where the file is in /configuration/main.py but it contains a datastructure called 'settings'.		Because the aiko configuration files are, themselves, just python, you can also do <code>import configuration.main.settings</code> where the file is in /configuration/main.py but it contains a datastructure called 'settings'.
			=== MQTT ===

	~~== Software development ==~~		See [[Swagbadge2021_MQTT]]

	~~=== MQTT ===~~

	~~See [[Swagbadge2021_MQTT]]~~		== Software development ==

	=== Aiko ===		=== Aiko ===
Line 146:		Line 147:
	</pre>		</pre>

	~~=== Replacing the swagbadge application with your own ===~~

	~~Edit configuration/main~~.py ~~and set "application": "application/yourcode"~~		=== Testing code ===

			First write your code on your computer, and make sure it compiles ( python -m py_compile code.py )

			Then, you can go in repl and use paste mode (^E). It only works if you paste a few lines at a time. End your paste with ^D and then if you pasted a function, call the function:
			<pre>
			>>> ^E
			paste mode; Ctrl-C to cancel, Ctrl-D to finish
			=== PASTE_YOUR_CODE_HERE
			=== ^D
			>>>
			</pre>

	=== Pushing new code ===		=== Pushing new code ===
Line 163:		Line 173:

	More details in https://spectrum.chat/lca2021-swagbadge/software/safe-software-updates~ba541e3c-d8a2-41a8-ac47-71d87696de2d		More details in https://spectrum.chat/lca2021-swagbadge/software/safe-software-updates~ba541e3c-d8a2-41a8-ac47-71d87696de2d

			=== Replacing the swagbadge application with your own ===

			Edit configuration/main.py and set "application": "application/yourcode"

	=== Reboot to shell / Force runaway code to stop ===		=== Reboot to shell / Force runaway code to stop ===

Marcmerlin: /* MQTT */

2021-01-16T23:22:47Z

MQTT

← Older revision		Revision as of 23:22, 16 January 2021
Line 126:		Line 126:
	=== MQTT ===		=== MQTT ===

	See [[~~Link~~ Swagbadge2021_MQTT]]		See [[Swagbadge2021_MQTT]]

	=== Aiko ===		=== Aiko ===

Marcmerlin at 23:22, 16 January 2021

2021-01-16T23:22:17Z

← Older revision		Revision as of 23:22, 16 January 2021
Line 121:		Line 121:

	Because the aiko configuration files are, themselves, just python, you can also do <code>import configuration.main.settings</code> where the file is in /configuration/main.py but it contains a datastructure called 'settings'.		Because the aiko configuration files are, themselves, just python, you can also do <code>import configuration.main.settings</code> where the file is in /configuration/main.py but it contains a datastructure called 'settings'.

			== Software development ==

	=== MQTT ===		=== MQTT ===

Marcmerlin at 23:20, 16 January 2021

2021-01-16T23:20:10Z

@@ Line 121: / Line 121: @@
 Because the aiko configuration files are, themselves, just python, you can also do <code>import configuration.main.settings</code> where the file is in /configuration/main.py but it contains a datastructure called 'settings'.
 === Aiko ===
 == Hardware reference ==

Nicola at 04:38, 16 January 2021

2021-01-16T04:38:18Z

@@ Line 78: / Line 78: @@
 </nowiki>
 </div></div>
 == Software reference ==

Nicola: /* Sample code */

2021-01-16T04:23:35Z

Sample code

← Older revision		Revision as of 04:23, 16 January 2021
Line 20:		Line 20:
	It demonstrates how to use the Aiko event loop to periodically poll for hardware state, as well as how to access some of the features of the badge.		It demonstrates how to use the Aiko event loop to periodically poll for hardware state, as well as how to access some of the features of the badge.

	You can find more example code in the ~~```~~examples~~```~~ directory of the [https://github.com/geekscape/aiko_engine_mp/tree/master/examples Aiko repository] on github.		You can find more example code in the '''examples''' directory of the [https://github.com/geekscape/aiko_engine_mp/tree/master/examples Aiko repository] on github.

	<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">		<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">