common

Documentation

Index

• Variables
• func CheckFlags(fqbn, address string)
• func DownloadRequiredToolsForBoard(pm *packagemanager.PackageManager, board *firmwareindex.IndexBoard) *paths.Path
• func GetBoard(firmwareIndex *firmwareindex.Index, fqbn string) *firmwareindex.IndexBoard
• func InitIndexes() (*packagemanager.PackageManager, *firmwareindex.Index)

Variables

var AdditionalFirmwareIndexURLs []string

AdditionalFirmwareIndexURLs is a list of additional module_firmware_index.json URLs that are loaded together with the main index.

var AdditionalPackageIndexURLs []string

AdditionalPackageIndexURLs is a list of additional package_index.json URLs that are loaded together with the main index.

Functions

func CheckFlags

func CheckFlags(fqbn, address string)

CheckFlags runs a basic check, errors if the flags are not defined

func DownloadRequiredToolsForBoard

func DownloadRequiredToolsForBoard(pm *packagemanager.PackageManager, board *firmwareindex.IndexBoard) *paths.Path

DownloadRequiredToolsForBoard is an helper function that downloads the correct tool to flash a board, it returns the path of the downloaded tool

func GetBoard

func GetBoard(firmwareIndex *firmwareindex.Index, fqbn string) *firmwareindex.IndexBoard

GetBoard is an helper function useful to get the IndexBoard, the struct that contains all the infos to make all the operations possible

func InitIndexes

func InitIndexes() (*packagemanager.PackageManager, *firmwareindex.Index)

InitIndexes downloads and parses the package_index.json and firmwares_index.json