Hello 👋 - if you've landed at this repo it's probably because you are one of the lucky people at GitHub Universe 2024 who has been handed a hackable conference badge and you are now wondering what the heck this thing is and how you can get started.
The GitHub Universe Badger is a hackable conference badge running MicroPython on a RP2350a microprocessor and comes with a built in 2.9" E Ink® display (296 x 128 pixels) along with a battery connector, 5 user configurable buttons and a QT/Stemma expansion port for connecting additional sensors and accessories. The GitHub Universe Badger is a custom version of the Badger2040 made by our wonderful friends at Pimoroni. Electronically we kept it pretty similar so that all the open source examples that you can find of cool things you can do with your Badger2040 you can do with your brand new GitHub Badger. We just blinged up the PCB a bit, added the latest RP2350a microprocessor and installed some little easter eggs into the BadgerOS image hung around your neck.
P.S. if you happen to have an electronic badge from Universe 2023 as well, most of the code provided in this repo will work on that older version too! Just one small note: the launcher on the 2023 model can only use JPEG files for app icons, while the 2024 also supports PNGs.
If you badge is currently blank, you first need to add your details to it.
- Visit the Badge Press in Google Chrome or Microsoft Edge
- Enter your GitHub Handle and the adjust the name and job title that you would like to be displayed
- Plug the badger into your computer with a USB C cable.
- Press the "Copy to badge" button. You will then be prompted to select the badger to communicate with via the serial port.
- Your badge should reboot with your badge details on it.
If you want to just play with the badge you have, you can plug it into power via the USB-C connection. You can also power via the JST power connector that can accept a 2xAAA battery pack ot standard 3.7v LiPo cell. If you wish, you may also print a back for the badge to house the LiPo battery using the STL file in this repo. The back will need (2) M2x8 screws to secure the badger to the 3D printed back.
To get started, read through the tutorial, which will guide you through the process of setting up your development environment and loading MicroPython scripts onto your badge. If you've never used a Pimoroni badge before, start here!
Once you've learned the basics, explore the examples folder, which contains fun and engaging apps that you can load directly onto your badge, or use as inspiration to create your own.
Also take note of the icons folder. Each app you load onto your badge needs an icon, and these need to be in a very specific format (as explained in the tutorial). While you can always choose to make your own icons, it may be easier/faster to just copy and rename one from this folder.
Lastly, the feature and function reference 2040reference.md contains detailed information about Badger programming. You don't need read it before trying out the tutorial -- but we wanted to make sure you had a copy in case you later decide to get deep into the world of Badger programming!
This is a full Raspberry Pi Pico device, so you aren't limited to MicroPython. If you want to entirely flash your firmware and turn your badger into a USB Macro Keyboard, or make it play Doom, then all that and more is possible! We've deliberately left solderable expansion pins available on your badge, as well as a serial QT/Stemma port, so you can connect your badge to a whole ecosystem of sensors from the likes of Adafruit and Pimoroni. To learn more about Stemma see this excellent tutorial from Adafruit.
After you've loaded a few examples onto your badge, have fun showing it off to others, and encourage them to come by the Hack Your Badge station on the second floor of the Gateway Pavilion, or return to this repository at any time to explore further.
Happy hacking, and once again, thank you for being part of GitHub Universe 2024!
As well as the Badger2040, there is a thriving community of badge hackers at open source and security events. Be sure to check out Badge.team if you are thinking about creating your own.
