Swagbadge2021 GettingStarted
Contents
Getting started with the Swagbadge
My package arrived in the mail, first steps.
- Your package should contain your badge! [insert photo here]
- Take off the protective cases to reveal the screens.
- Powering it up
- Insert the micro USB cable into the badge and connect the other end to a USB port on your computer or USB power source.
- A green light should glow on the rear of the board, and a title appear across the two screens.
- Turning it on and off again
- Plugging/unplugging it is fine. Usually the badge isn't running anything intensely enough that just unpowering it would cause a problem.
- On bootup, you should see:
- The OLED screens will display "Aiko" and a version number as a title
- It will also display something else to tell you to set up your wifi.
Getting it on your network
- Safety precautions we have provided
- When using any hardware ordered off the internet, you can't be quite certain what software might be present on it. Before shipping these badges to you, we reflashed a fresh copy of MicroPython onto the Lolin32.
- The framework running on the badge is Aiko, which is open source.
- The software on the badge is available on the CCHS repository, also all open source.
- The badges are designed to communicate over MQTT - a lightweight standard for messaging on IoT devices, but we are aware of privacy considerations: you don't want anybody able to control your badge from afar. The swagbadge protocol provides support for encrypted messages.
- Restart device
- The first time you boot your device, it won't know how to talk to your network. If it can't detect a pre-existing set of network credentials, or connect to anything it knows about, it will establish a temporary access point and prompt you to navigate to it to enter your wifi details.
- Note: Your device can only talk to a 2G network: it is not compatible with 5g.
- This will look like ...
- You can now restart your device
- On bootup you should now see...
Running pre-installed applications
- Pre-installed things, how to access and run them.
Extensions: Adding a SAO
- provided by others
- build your own (linky here to our docs)
Extensions: Updating the software framework
Between when we ship the board and when it arrives, there might be some changes to the software framework (Aiko). Here's how to update it. Or perhaps you're interested in writing your own applications?
