Skip to content

Latest commit

 

History

History
94 lines (60 loc) · 3.65 KB

BUILDING.md

File metadata and controls

94 lines (60 loc) · 3.65 KB
Raw

Building Porky

NOTE: These instructions below apply equally, whether you have cloned the repo or have downloaded and exploded the source tarball/zip of a release.

NOTE: None of the developers currently has a Windows machine, so we have been unable to test this on Windows.

cd pigg/porky

Building

make

will run build a release DWARF binary for the Raspberry Pi Pico W here:

  • pigg/porky/target/thumbv6m-none-eabi/release/porky

How SSID information is used by porky

The startup process of porky is:

  • Try to load SSID information from Flash memory
  • If none is present try and use the default SSID information compiled in as part of the build
  • If no default information was built in, then porky has no SSID information and will not try to connect to a Wi-Fi network
  • USB connection is always started and will be able to receive SSID information from piggui. This will be stored in the Flash memory and used in the above process at next start

Configuring with override SSID information

As described, the default information can be overridden by supplying other SSID details that are stored in Flash memory.

See the section in README.md on that for details of how to do it using piggui

Customizing the default SSID information

It is possible to customize the default SSID (Wi-Fi network) information that porky tries to use to connect to a Wi-Fi network on startup, if you are building from source. Then all devices programmed with that build will automatically try to connect to that Wi-Fi network at startup, without having to use piggui and USB.

The build process looks for the presence of a valid SSID specification file (called ssid.toml) in TOML format in the proky project root directory (i.e. In pigg/porky/ beside Cargo.toml).

The format of ssid.toml must be like this:

ssid_name = "SSID Name"
ssid_pass = "SSID Password"
security = "wpa2"

Valid values for the security field are: open, wpa, wpa2 and wpa3

Create this file with your SSID information in it and then run the makefile make target, and it will produce a porky binary with that SSID as the default SSID. Run make uf2 to generate a UF2 file for download.

Running Directly

NOTE: Running directly requires a debug probe attached to your device and host, and probe-rs installed.

If you have a debug probe for the Pico, and it is connected and also the Pico is connected to USB then you can use probe-rs to download and debug porky.

config.toml is where the runner for cargo is set up.

You can use make run (which uses cargo run --release) to run porky directly.

The release binary is about half the size of the debug binary, so downloading to the Pico W is much faster.

The Pi Pico will start running porky and you should start seeing log messages on the terminal where you are running make run. The boot process should end with porky connected to the configured (or default) Wi-Fi network, and the output of its IP and the port it is listening for TCP connections on.

Creating a UF2 file

Use make uf2 Makefile target.

This uses the elf2usb2 command which you can install using cargo.

This will produce the file target/thumbv6m-none-eabi/release/porky_pico_w.uf2

You can check its type using: file target/thumbv6m-none-eabi/release/porky_pico_w.uf2:

target/thumbv6m-none-eabi/release/porky_pico_w.uf2: UF2 firmware image, family Raspberry Pi RP2040, address 0x10000000, 1608 total blocks

See section in README.md for how to use your newly created UF2 file.