HOPE XV Electronic Badge - Revision history

Fortuna: Add ESPHome

2025-08-15T19:53:58Z

Add ESPHome

← Older revision		Revision as of 19:53, 15 August 2025
Line 8:		Line 8:
	<Must-still-be-uploaded><br>		<Must-still-be-uploaded><br>
	hopebadge-0.8.14.bin		hopebadge-0.8.14.bin

			Or flash it with ESPHome, which is an easy way to write firmware for your badge:
			https://github.com/fortuna/ESPHomeBadge

	= Badge Clinic =		= Badge Clinic =

Fortuna: Clarify button number

2025-05-11T01:40:52Z

Clarify button number

← Older revision		Revision as of 01:40, 11 May 2025
Line 230:		Line 230:
	esptool.py write_flash --flash_mode=dio 0x0 ~/Downloads/ESP32_GENERIC_C3-20250415-v1.25.0.bin</nowiki>		esptool.py write_flash --flash_mode=dio 0x0 ~/Downloads/ESP32_GENERIC_C3-20250415-v1.25.0.bin</nowiki>

	''If no serial device is found, try holding down ~~the~~ <code>SW2</code> ~~button~~ while switching on the badge to put it in "safe mode".''		''If no serial device is found, try holding down Button 4 (<code>SW2</code>) while switching on the badge to put it in "safe mode".''

	When finished, make note of the serial port auto-detected by esptool.py (ex. <code>/dev/ttyACM0</code>). You should now be able to get a Python console with:		When finished, make note of the serial port auto-detected by esptool.py (ex. <code>/dev/ttyACM0</code>). You should now be able to get a Python console with:

Fortuna: Update MicroPython information with pin information and mpremote

2025-04-22T03:37:07Z

Update MicroPython information with pin information and mpremote

← Older revision		Revision as of 03:37, 22 April 2025
Line 239:		Line 239:

	''If you only see a blank screen, try pressing Enter and/or turning the badge off and back on again.''		''If you only see a blank screen, try pressing Enter and/or turning the badge off and back on again.''

			For a better experience, and to copy files to the device, install [https://docs.micropython.org/en/latest/reference/mpremote.html mpremote].

			To run the REPL:
			<nowiki>mpremote</nowiki>

			To run a local script:
			<nowiki>mpremote run main.py</nowiki>

			To make a script to run on restarts:
			<nowiki>mpremote fs cp main.py :</nowiki>

	== Snippets ==		== Snippets ==
Line 279:		Line 290:

	=== Buttons ===		=== Buttons ===
			Example:
	~~2/4 buttons work, perhaps [https~~:~~//github.com/micropython/micropython/issues/12479 because of this]? Please update this if you discover a solution!~~

	<nowiki>from machine import Pin		<nowiki>from machine import Pin
Line 291:		Line 301:
	sw1_pin.value() # pressing SW1		sw1_pin.value() # pressing SW1
	0</nowiki>		0</nowiki>

			2/4 buttons work, because buttons 1 (SW3) and 2 (SW4) are assigned to USB D+/D-, and the Micropython firmware for ESP32-C3 doesn't define them ([https://github.com/micropython/micropython/blob/master/ports/esp32/machine_pin.h source code]), resulting on an <code>invalid pin</code> error on usage (see [https://github.com/micropython/micropython/issues/12479]). A custom MicroPython firmware needs to be built to bypass the restriction (TODO, probably just need to define <code>MICROPY_HW_ENABLE_GPIO18</code> and <code>MICROPY_HW_ENABLE_GPIO19</code>).

Fortuna: Clarify installation steps for MicroPython

2025-04-22T02:41:12Z

Clarify installation steps for MicroPython

← Older revision		Revision as of 02:41, 22 April 2025
Line 224:		Line 224:
	'''Note''': this will erase [https://gitlab.com/tidklaas/hip-badge the HOPE firmware], so please obtain a copy if you'd like to flash it back.		'''Note''': this will erase [https://gitlab.com/tidklaas/hip-badge the HOPE firmware], so please obtain a copy if you'd like to flash it back.

	~~Using the~~ [https://docs.espressif.com/projects/esptool/en/latest/esp32/installation.html esptool.~~py flasher utility~~]:		# [https://docs.espressif.com/projects/esptool/en/latest/esp32/installation.html Install <code>esptool</code>]
			# Download the MicroPython Firmware for ESP32-C3 from [https://micropython.org/download/ESP32_GENERIC_C3/]
			# Flash the firmware:
	<nowiki>esptool.py erase_flash		<nowiki>esptool.py erase_flash
	esptool.py write_flash --flash_mode=dio 0x0 ~/Downloads/ESP32_GENERIC_C3-~~20240602~~-v1.23.0.bin</nowiki>		esptool.py write_flash --flash_mode=dio 0x0 ~/Downloads/ESP32_GENERIC_C3-20250415-v1.25.0.bin</nowiki>

	''If no serial device is found, try holding down the <code>SW2</code> button while switching on the badge to put it in "safe mode".''		''If no serial device is found, try holding down the <code>SW2</code> button while switching on the badge to put it in "safe mode".''

Fortuna: Add `--flash_mode=dio` to ensure it doesn't use qio flash mode.

2025-04-22T01:55:24Z

Add `--flash_mode=dio` to ensure it doesn't use qio flash mode.

← Older revision		Revision as of 01:55, 22 April 2025
Line 227:		Line 227:

	<nowiki>esptool.py erase_flash		<nowiki>esptool.py erase_flash
	esptool.py write_flash 0x0 ~/Downloads/ESP32_GENERIC_C3-20240602-v1.23.0.bin</nowiki>		esptool.py write_flash --flash_mode=dio 0x0 ~/Downloads/ESP32_GENERIC_C3-20240602-v1.23.0.bin</nowiki>

	''If no serial device is found, try holding down the <code>SW2</code> button while switching on the badge to put it in "safe mode".''		''If no serial device is found, try holding down the <code>SW2</code> button while switching on the badge to put it in "safe mode".''

Duneedon: Add a note about power cycling the badge after flashing

2024-08-20T19:51:47Z

Add a note about power cycling the badge after flashing

← Older revision		Revision as of 19:51, 20 August 2024
Line 236:		Line 236:
	>>> print('hello world')		>>> print('hello world')
	hello world</nowiki>		hello world</nowiki>

			''If you only see a blank screen, try pressing Enter and/or turning the badge off and back on again.''

	== Snippets ==		== Snippets ==

Duneedon: Add a MicroPython section with some helpful code snippets

2024-08-20T19:47:15Z

Add a MicroPython section with some helpful code snippets

← Older revision		Revision as of 19:47, 20 August 2024
Line 215:		Line 215:
	[[File:UsersManualPage1.jpg\|500px\|center]]<br>		[[File:UsersManualPage1.jpg\|500px\|center]]<br>
	<br>		<br>

			= MicroPython =

			[https://micropython.org/download/ESP32_GENERIC_C3/ MicroPython firmware] can be flashed on the badge to explore its features with an interactive Python console. When finished, you can [https://github.com/dhylands/rshell copy your code] to <code>/boot.py</code> to have it run each time it's powered on.

			== Installation ==

			'''Note''': this will erase [https://gitlab.com/tidklaas/hip-badge the HOPE firmware], so please obtain a copy if you'd like to flash it back.

			Using the [https://docs.espressif.com/projects/esptool/en/latest/esp32/installation.html esptool.py flasher utility]:

			<nowiki>esptool.py erase_flash
			esptool.py write_flash 0x0 ~/Downloads/ESP32_GENERIC_C3-20240602-v1.23.0.bin</nowiki>

			''If no serial device is found, try holding down the <code>SW2</code> button while switching on the badge to put it in "safe mode".''

			When finished, make note of the serial port auto-detected by esptool.py (ex. <code>/dev/ttyACM0</code>). You should now be able to get a Python console with:

			<nowiki>screen /dev/ttyACM0
			>>> print('hello world')
			hello world</nowiki>

			== Snippets ==

			Please see the [https://docs.micropython.org/en/latest/esp32/quickref.html Quick reference for the ESP32] for helpful snippets.

			=== WiFi ===

			WiFi works (please see [https://docs.micropython.org/en/latest/esp32/quickref.html#wlan this guide]), with one caveat: maybe my badge is faulty, but I had to reduce the transmit power level slightly to connect to an access point:

			<nowiki>import network

			wlan = network.WLAN(network.STA_IF)
			wlan.active(True)

			wlan.config(txpower = 14) # HACK: see note above

			wlan.connect('my-ssid', 'my-key')
			wlan.isconnected() # wait until True
			wlan.ifconfig()
			</nowiki>

			=== LEDs ===

			A NeoPixel library is available to work with the LED strip:

			<nowiki>
			import neopixel
			from machine import Pin

			pin = Pin(8, Pin.OUT)
			neo = neopixel.NeoPixel(pin, 16)

			# Draw a red gradient.
			for i in range(16):
			neo[i] = (i * 8, 0, 0)

			# Update the strip.
			neo.write()</nowiki>

			=== Buttons ===

			2/4 buttons work, perhaps [https://github.com/micropython/micropython/issues/12479 because of this]? Please update this if you discover a solution!

			<nowiki>from machine import Pin

			sw1_pin = Pin(10, Pin.IN, Pin.PULL_UP)
			sw2_pin = Pin(9, Pin.IN, Pin.PULL_UP)

			sw1_pin.value()
			1
			sw1_pin.value() # pressing SW1
			0</nowiki>

Maltman23: /* User Manual */

2024-08-14T14:16:19Z

User Manual

← Older revision		Revision as of 14:16, 14 August 2024
Line 208:		Line 208:

	The User Manual has a lot of useful information -- you can see the PDF [https://wiki.hope.net/images/6/6b/HOPE_XV_Electronic_Badge_User_Manual.pdf here]:<br>		The User Manual has a lot of useful information -- you can see the PDF [https://wiki.hope.net/images/6/6b/HOPE_XV_Electronic_Badge_User_Manual.pdf here]:<br>
	[https://wiki.hope.net/images/6/6b/HOPE_XV_Electronic_Badge_User_Manual.pdf HOPE XV Electronic Badge User Manual]]<br>		[https://wiki.hope.net/images/6/6b/HOPE_XV_Electronic_Badge_User_Manual.pdf HOPE XV Electronic Badge User Manual]<br>
	[[File:UsersManualPage1.jpg\|500px\|center]]		[[File:UsersManualStandardPage1.jpg\|500px\|center]]<br>
			<br>
			Here is the User Manual for the Pro model of the [https://wiki.hope.net/images/5/56/HOPE_XV_Electronic_Badge_Pro_User_Manual.pdf HOPE XV electronic badge]:<br>
			[https://wiki.hope.net/images/5/56/HOPE_XV_Electronic_Badge_Pro_User_Manual.pdf HOPE XV Pro Model User Manual]
			[[File:UsersManualPage1.jpg\|500px\|center]]<br>
	<br>		<br>

Maltman23: /* Firmware */

2024-07-23T01:00:01Z

Firmware

← Older revision		Revision as of 01:00, 23 July 2024
Line 6:		Line 6:

	= Firmware =		= Firmware =
	<Must-still-be-uploaded>		<Must-still-be-uploaded><br>
	~~System administrator, please find a way to allow me to upload a file called:~~

	hopebadge-0.8.14.bin		hopebadge-0.8.14.bin

	...if you want I will compress it in some way or modify its filename or file extension. Nothing I've tried so far has worked. If you want to test this, just make a empty file with the name above and try to upload it.

	= Badge Clinic =		= Badge Clinic =

Maltman23 at 22:32, 18 July 2024

2024-07-18T22:32:02Z

← Older revision		Revision as of 22:32, 18 July 2024
Line 1:		Line 1:


	[[File:~~Hopexv-badge-front~~.jpg\|thumb\|500px\|The HOPE XV Electronic Badge PCB (front)]]<br>		[[File:HOPE_XV_electronic_badge_photo_front.jpg\|thumb\|500px\|The HOPE XV Electronic Badge PCB (front)]]<br>
	[[File:Hopexv-badge-back.jpg\|thumb\|500px\|The HOPE XV Electronic Badge PCB (back)]]<br>		[[File:Hopexv-badge-back.jpg\|thumb\|500px\|The HOPE XV Electronic Badge PCB (back)]]<br>