util

Documentation

Index

• func ArrayContains(arr []string, str string) bool
• func CleanDataDirectory(dir string) error
• func CreateDataDir(dir string) error
• func GenArdiConfig() *types.ArdiConfig
• func GenArduinoCliSettings(dataDir string) *types.ArduinoCliSettings
• func GeneratePropsArray(props map[string]string) []string
• func GeneratePropsMap(buildProps []string) map[string]string
• func GetAllSettings() (*types.ArdiConfig, *types.ArduinoCliSettings)
• func GetCliSettingsPath() string
• func InitProjectDirectory() error
• func IsProjectDirectory() bool
• func ParseSketchBaud(sketch string) int
• func ProcessSketch(filePath string) (*types.Project, error)
• func ReadArdiConfig(confPath string) (*types.ArdiConfig, error)
• func ReadArduinoCliSettings(confPath string) (*types.ArduinoCliSettings, error)
• func WriteAllSettings(ardiConfig *types.ArdiConfig, arduinoSettings *types.ArduinoCliSettings) error

Functions

func ArrayContains

func ArrayContains(arr []string, str string) bool

ArrayContains checks if a string array contains a value

func CleanDataDirectory

func CleanDataDirectory(dir string) error

CleanDataDirectory removes directory

func CreateDataDir

func CreateDataDir(dir string) error

CreateDataDir creates a data dir with proper permissions for ardi / arduino-cli

func GenArdiConfig

func GenArdiConfig() *types.ArdiConfig

GenArdiConfig returns default ardi.json in current directory

func GenArduinoCliSettings

func GenArduinoCliSettings(dataDir string) *types.ArduinoCliSettings

GenArduinoCliSettings generated data config file with default values

func GeneratePropsArray

func GeneratePropsArray(props map[string]string) []string

GeneratePropsArray returns an arrary of props from props map

func GeneratePropsMap

func GeneratePropsMap(buildProps []string) map[string]string

GeneratePropsMap returns map of build props from string array

func GetAllSettings

func GetAllSettings() (*types.ArdiConfig, *types.ArduinoCliSettings)

GetAllSettings returns settings for both ardi and arduino-cli

func GetCliSettingsPath

func GetCliSettingsPath() string

GetCliSettingsPath returns path to arduino-cli.yaml based on scope

func InitProjectDirectory

func InitProjectDirectory() error

InitProjectDirectory initializes a directory as an ardi project

func IsProjectDirectory

func IsProjectDirectory() bool

IsProjectDirectory returns whether or not currect directory has been initialized as an ardi project

func ParseSketchBaud

func ParseSketchBaud(sketch string) int

ParseSketchBaud reads a sketch file and tries to parse baud rate

func ProcessSketch

func ProcessSketch(filePath string) (*types.Project, error)

ProcessSketch looks for .ino file in specified directory and parses

func ReadArdiConfig

func ReadArdiConfig(confPath string) (*types.ArdiConfig, error)

ReadArdiConfig reads ardi.json and returns config

func ReadArduinoCliSettings

func ReadArduinoCliSettings(confPath string) (*types.ArduinoCliSettings, error)

ReadArduinoCliSettings reads data config file and returns unmarshalled data and stringified version

func WriteAllSettings

func WriteAllSettings(ardiConfig *types.ArdiConfig, arduinoSettings *types.ArduinoCliSettings) error

WriteAllSettings writes all settings files