Skip to content

Manual Installation

Most users should use wificom-update-tool as described in Device Setup instead!

CircuitPython

wificom-lib runs on CircuitPython 8.x. Check the CHANGELOG for the exact version tested with each release.

Release Zips

wificom-lib releases bundle all required libraries, and are compiled to mpy format for faster startup.

Manual Installation

  1. Install CircuitPython, checking board and version as above
  2. Download the latest release from releases page, you'll be looking for a file named "wificom-lib_RELEASEVERSION.zip" or "wificom-lib_RELEASEVERSION_picow.zip"
  3. Extract the zip
  4. If you are using an unsupported board or custom circuit layout, modify "board_config.py" so the pinouts match your board
  5. Copy the files into the root of the CIRCUITPY drive
  6. Add secrets.py, either by modifying secrets.example.py, or you can get a prefilled version on wificom.dev
  7. Safely remove / eject the CIRCUITPY drive from your computer
  8. Cold reboot the WiFiCom (remove and restore power)

Manual Update

  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
  6. Compare contents of your modified files with the new files and make any necessary changes
  7. Copy the files into the root of the CIRCUITPY drive
  8. Safely remove / eject the CIRCUITPY drive from your computer
  9. Reboot the WiFiCom using one of the options indicated

Libraries

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.

Server

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