Module espflash::cli

Available on crate feature cli only.

Types and functions for the command-line interface

The contents of this module are intended for use with the cargo-espflash and espflash command-line applications, and are likely not of much use otherwise.

Important note: The cli module DOES NOT provide SemVer guarantees, feel free to opt-out by disabling the default cli feature.

Modules

• config
  Command-line interface configuration
• monitor
  Serial monitor utility

Structs

• ChecksumMd5Args
• CompletionsArgs
  Generate completions for the given shell
• ConnectArgs
  Establish a connection with a target device
• EraseFlashArgs
  Erase entire flash of target device
• EraseRegionArgs
  Erase specified region of flash
• EspflashProgress
  Progress callback implementations for use in cargo-espflash and espflash
• FlashArgs
  Flash an application to a target device
• FlashConfigArgs
  Configure communication with the target device’s flash
• MonitorArgs
  Open the serial monitor without flashing
• PartitionTableArgs
  Operations for partitions tables
• ReadFlashArgs
  Reads the content of flash memory and saves it to a file
• SaveImageArgs
  Save the image to disk instead of flashing to device

Functions

• board_info
  Connect to a target device and print information about its chip
• checksum_md5
  Connect to a target device and calculate the checksum of the given region
• completions
  Generate shell completions for the given shell
• connect
  Select a serial port and establish a connection with a target device
• erase_flash
• erase_partitions
  Erase one or more partitions by label or DataType
• erase_region
• flash_elf_image
  Write an ELF image to a target device’s flash
• parse_chip_rev
  Parses chip revision from string to major * 100 + minor format
• parse_u32
• parse_uint32
  Parses a string as a 32-bit unsigned integer.
• partition_table
  Convert and display CSV and binary partition tables
• print_board_info
  Print information about a chip
• read_flash
  Read flash content and write it to a file
• save_elf_as_image
  Convert the provided firmware image from ELF to binary
• serial_monitor
  Open a serial monitor