esp32fw

README

ESP32 Firmware Tool

This repository is a rewrite version based on previously created repository that is written in Python language. You can find the repository here

Documentation

Index

• Variables
• type Firmware
  • func (f *Firmware) Build() error
  • func (f *Firmware) SetOutputPath(outputPath string) error
  • func (f *Firmware) SetRecipes(recipes []FirmwareRecipe) error
• type FirmwareRecipe

Variables

var ErrEmptyOutputPath = errors.New("output path is empty")

ErrEmptyOutputPath Error returned when output path to a firmware is empty

var ErrEmptyRecipes = errors.New("recipes for firmware is empty")

ErrEmptyRecipes Error returned when firmware has no recipes

Types

type Firmware

type Firmware struct {
	// contains filtered or unexported fields
}

Firmware ESP32 firmware object

func (*Firmware) Build

func (f *Firmware) Build() error

Build build the firmware from recipes

func (*Firmware) SetOutputPath

func (f *Firmware) SetOutputPath(outputPath string) error

SetOutputPath set the path to the output file of the firmware

func (*Firmware) SetRecipes

func (f *Firmware) SetRecipes(recipes []FirmwareRecipe) error

SetRecipes set the recipes for the firmware

type FirmwareRecipe

type FirmwareRecipe struct {
	Offset uint   // offset of the binary file, usually represented in hexadecimal number
	Path   string // relative path to the binary file.
}

FirmwareRecipe ESP32 firmware is built from several binary files with their own offset. This struct represents the path to a binary file and its offset.