This library enables an RP2040+WiFi device using dmcomm-python (CircuitPython 8.x) to connect to https://wificom.dev to enable DigiROM reading and writing via HTTP API calls and MQTT for device interactions.

• Raspberry Pi Pico W - RECOMMENDED OPTION
• Arduino Nano Connect
• RP2040 with AirLift co-processor module
  • Pi Pico is the only tested board so far but others should work as well

• RP2040 Challenger with WiFi Chip
  • Issues with SSL with onboard chip; doesn't allow for secure requests
• RP2040 Challenger with WiFi/BLE Chip
  • Issues with SSL with onboard chip; doesn't allow for secure requests

• Visit https://dmcomm.github.io/guide/pi-pico/ for more information on this topic
• Ensure you match pins on your supported board with those found in the example "board_config.py" file. The pins have been optimized by BladeSabre for the boards found in "board_config.py". If you have a different board or require a different pin layout, you will need to adjust the pins in the "board_config.py" file.

• Code with Mu is recommended. Choose CircuitPython and click the "Serial" button.
• Note that Arduino IDE has some difficulties with CircuitPython serial.

• The WiFiCom Update Tool can download and install/update your choice of WiFiCom version automatically.
• CircuitPython needs to be installed/updated separately, see below for details.

1. Install CircuitPython 8.x to the board: see sources.json for the exact version tested
   • Raspberry Pi Pico W: Latest / All
   • Arduino Nano RP2040 Connect: Latest / All
   • Pico with AirLift: Latest / All
2. Download the latest release from releases page, you'll be looking for a file named "wificom-lib_RELEASEVERSION_picow.zip" for Pi Pico W, or "_nina.zip" for other types
3. Extract the zip and copy the contents into the root of the CIRCUITPY drive
   • If you are using an unsupported board or custom circuit layout, then before copying to CIRCUITPY, modify "board_config.py" so that pinouts match your board
4. Copy the "secrets.example.py" to "secrets.py" and make changes to match your environment (you can get a prefilled version on the website https://wificom.dev)
5. Check that the system boots, then eject CIRCUITPY from the computer and replug the USB to enable the boot.py configuration
6. Test that everything works, you should see the following output on serial after the screen comes up and you select "Wifi"

   10:59:45.103 -> Connecting to WiFi network [WIFI_SSID]...
   10:59:46.387 -> Connected to WiFi network!
   10:59:46.423 -> Connecting to MQTT Broker...
   10:59:47.046 -> Connected to MQTT Broker! 
   10:59:47.481 -> Subscribed to USERNAME/f/1111111111111111-2222222222222222/wificom-input with QOS level 0
   

7. If you need to change any files, put the WiFiCom into drive mode (or dev mode if necessary) using the instructions below

1. Backup your current files, in particular the following are commonly modified:
   • secrets.py
   • board_config.py
   • config.py (previously digiroms.py)
2. Update CircuitPython if required
3. Put the WiFiCom into drive mode so that the CIRCUITPY drive is writeable
4. Download the latest release from releases page, named as above
5. Extract the zip and copy the contents into the root of the CIRCUITPY drive
6. Compare contents of your modified files with the new files and make any necessary changes
7. Test that everything works, including connecting to WiFi and sending/receiving DigiRoms

The UI has a small screen and 3 buttons. Some features are supported on a minimal build with only one button and no screen, but the full build is recommended.

• Button A: select menu options
• Button B: activate selected option
• Button C: cancel/return (needs to be held for several seconds when device is busy)

• WiFi: Connect to WiFi and MQTT and await instructions from the server
• Serial: Act as a normal serial com unit
• Punchbag: Communicate with the toys in a standalone mode (you can edit config.py to change the available options in this submenu)
• Drive: Make the CIRCUITPY drive writeable so you can edit configuration or update firmware

• Raspberry Pi Pico W: external LED is required
• Arduino Nano RP2040 Connect: on-board orange LED
• Raspberry Pi Pico: on-board green LED

• Fast blinking indicates connecting to WiFi and MQTT
• Solid (dimmed) LED indicates connected and no errors
• Solid (bright) LED indicates waiting for Digimon/Legendz device during real-time battle
• LED OFF with short blinks indicates a managed failure, follow the instructions on the screen, or on screenless units press the button to restart
• LED OFF indicates failure, please restart your device
• During startup, see below

• To use "WiFiCom mode (with drive read-only)", do not press the button
• To use "WiFiCom mode (with full drive access)", also known as "Dev mode", hold the C button until the LED comes on, then release
• To use "Serial Only mode", hold the C button until the LED comes on, and keep holding until the LED goes dim or off

Runs on CircuitPython 8.x. Check sources.json for the exact version tested with each release.

These are included in the release zip. If installing manually, check sources.json for versions. In particular, adafruit_minimqtt is likely to break if a different version is used from the one specified.

• dmcomm-python
• adafruit_bus_device
• adafruit_display_text
• adafruit_esp32spi
• adafruit_minimqtt
• adafruit_displayio_ssd1306
• adafruit_requests

wificom.dev is open-source. The code is available at:

• https://github.com/mechawrench/wificom-webapp/
• https://github.com/mechawrench/wificom-mosquitto-docker/

• BrassBolt - Co-Creator of the WiFiCom Project, initial Proof of Concept for idea, web service (author, host, and maintainer), long-time primary contributor to the WiFiCom project.
• BladeSabre - Creator of the library WiFiCom was created based on (find the project at dmcomm-python, co-creator of the WiFiCom project, original circuit design for both P-Com and WiFiCom components. Long-time primary contributor to the WiFiCom project.
• Xanthos - First to implement a premade fully featured WiFiCom device for other users, long term supporter of the project. Heavily involved in testing operations for the WiFiCom project. Much feedback since inception on the hardware level for the WiFiCom device.
• ManicBen - Vast source of knowledge and experience to the project, original direction for use of the Mosquitto protocol.
• Nizuma(zojo) - Guru of all things Legendz, original support for the project when implementing and testing Legendz. First seller of WiFiCom breadboard builds to the public, these were made using our first well-supported microcontroller, the Nano Connect.
• Seki - Creator of Digimon w0rld, provided for the very first App integration for the WiFiCom project which brought the project forward in a big way.
• blazeindarkness - Maintainer of the w0rld project, first tester of a premade WiFiCom unit (BrassBolt made). Continued support for the project and features we wish to have implemented across WiFiCom and the w0rld project.
• SunSoil || MintMaker - Maintainer of A-Com Wiki, has provided feedback, input, and knowledge-share that aided other WiFiCom projects.
• SigmaDolphin - Decoded the Legendz signal protocol, this helped to enable Real-Time Battles for Legendz toys.
• If we are missing anyone or anything, please let us know!