tree

Documentation

Overview

Package tree provides utility functions to manage the NAOS build tree.

Package tree provides utility functions to manage the NAOS build tree.

Index

• func ADFDirectory(naosPath string) string
• func AppBinary(naosPath string) ([]byte, error)
• func Attach(naosPath, port string, out io.Writer, in io.Reader) error
• func Build(naosPath, target string, overrides map[string]string, files []string, ...) error
• func Config(naosPath string, values map[string]string, port, baudRate string, ...) error
• func Directory(naosPath string) string
• func Exec(naosPath string, out io.Writer, in io.Reader, noEnv, usePty bool, name string, ...) error
• func Flash(naosPath, target, port, baudRate string, erase, appOnly, alt bool, ...) error
• func Format(naosPath string, out io.Writer) error
• func IDFDirectory(naosPath string) string
• func IDFMajorVersion(naosPath string) (int, error)
• func IDFVersion(naosPath string) (string, error)
• func IncludeDirectories(naosPath string) ([]string, error)
• func Install(naosPath, sourcePath, dataPath, version string, force bool, out io.Writer) error
• func InstallAudioFramework(naosPath, version string, force bool, out io.Writer) error
• func InstallComponent(projectPath, naosPath, name, path, repository, version string, force bool, ...) error
• func InstallRegistryComponents(projectPath, naosPath string, components []IDFComponent, force bool, ...) error
• func ParseCoredump(naosPath string, coredump []byte) ([]byte, error)
• func RequiredToolchain(naosPath string) (string, error)
• func SourceAndHeaderFiles(naosPath string) ([]string, []string, error)
• func WriteCMakeLists(naosPath string, out io.Writer) error
• type IDFComponent
• type Partitions

Functions

func ADFDirectory

func ADFDirectory(naosPath string) string

ADFDirectory returns the assumed location of the esp-adf directory.

Note: It will not check if the directory exists.

func AppBinary

func AppBinary(naosPath string) ([]byte, error)

AppBinary will return the bytes of the built app binary.

func Attach

func Attach(naosPath, port string, out io.Writer, in io.Reader) error

Attach will attach to the specified serial port using the idf.py monitor.

func Build

func Build(naosPath, target string, overrides map[string]string, files []string, partitions *Partitions, clean, reconfigure, appOnly bool, out io.Writer) error

Build will build the project.

func Config

func Config(naosPath string, values map[string]string, port, baudRate string, out io.Writer) error

Config will write settings and parameters to an attached device.

func Directory

func Directory(naosPath string) string

Directory returns the assumed location of the build tree directory.

Note: It will not check if the directory exists.

func Exec

func Exec(naosPath string, out io.Writer, in io.Reader, noEnv, usePty bool, name string, arg ...string) error

Exec runs a named command in the build tree. All xtensa toolchain binaries are made available in the path transparently.

func Flash

func Flash(naosPath, target, port, baudRate string, erase, appOnly, alt bool, out io.Writer) error

Flash will flash the project using the specified serial port.

func Format

func Format(naosPath string, out io.Writer) error

Format will format all source files in the project if 'clang-format' is available.

func IDFDirectory

func IDFDirectory(naosPath string) string

IDFDirectory returns the assumed location of the esp-idf directory.

Note: It will not check if the directory exists.

func IDFMajorVersion

func IDFMajorVersion(naosPath string) (int, error)

IDFMajorVersion will detect and return the major IDF version from the specified path.

func IDFVersion

func IDFVersion(naosPath string) (string, error)

IDFVersion will detect and return the IDF version from the specified path.

func IncludeDirectories

func IncludeDirectories(naosPath string) ([]string, error)

IncludeDirectories returns a list of directories that will be included in the build process.

func Install

func Install(naosPath, sourcePath, dataPath, version string, force bool, out io.Writer) error

Install will install the NAOS repo to the specified path and link the source path into the build tree.

func InstallAudioFramework

func InstallAudioFramework(naosPath, version string, force bool, out io.Writer) error

InstallAudioFramework will manage the esp-adf installation.

func InstallComponent

func InstallComponent(projectPath, naosPath, name, path, repository, version string, force bool, out io.Writer) error

InstallComponent will install the specified component in the build tree.

func InstallRegistryComponents

func InstallRegistryComponents(projectPath, naosPath string, components []IDFComponent, force bool, out io.Writer) error

InstallRegistryComponents will install the specified registry components.

func ParseCoredump

func ParseCoredump(naosPath string, coredump []byte) ([]byte, error)

ParseCoredump will parse the provided raw coredump data and return a human-readable representation.

func RequiredToolchain

func RequiredToolchain(naosPath string) (string, error)

RequiredToolchain returns the required toolchain version by the current NAOS installation.

func SourceAndHeaderFiles

func SourceAndHeaderFiles(naosPath string) ([]string, []string, error)

SourceAndHeaderFiles will return a list of source and header files.

func WriteCMakeLists

func WriteCMakeLists(naosPath string, out io.Writer) error

WriteCMakeLists will write a CMakeLists.txt with all included directories.

Types

type IDFComponent

type IDFComponent struct {
	Name    string
	Version string
}

IDFComponent represents a component in the idf-components.yml file.

type Partitions

type Partitions struct {
	Total   int // MiBs
	Alpha   int // %
	Beta    int // %
	Storage int // %
}

Partitions defines a percentage based partitioning scheme.