wallycli

package module
v0.0.0-...-05e2744 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 25, 2021 License: MIT Imports: 7 Imported by: 0

README

Wally cli

Flash your ZSA Keyboard the EZ way.

Getting started

Download the application for your favorite platform from the release page.

Note for Linux users, follow the instructions from our wiki page before running the application.

Note for Mac OS users, the CLI requires libusb to be installed: brew install libusb

You can also compile and install Wally using go's package manager, make sure you follow the Installing dev dependencies section for your platform below:

go get -u github.com/zsa/wally-cli

Installing dev dependencies

Wally is compatible with Windows, Linux, and macOS. Developing using each platform requires some extra setup:

Windows
  1. Install TDM GCC
  2. Setup pkg-config - see http://www.mingw.org/wiki/FAQ "How do I get pkg-config installed?"
  3. Grab and install the latest version of libusb from here
Linux

Follow the instructions from our wiki page

macOS

Install libusb using brew:

brew install libusb
build
go build ./cmd/wally-cli

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type BoardFlashMethod

type BoardFlashMethod func(firmwarePath string, s *FlashState) error

type BoardFlasher

type BoardFlasher struct {
	*FlashState
	// contains filtered or unexported fields
}

func New

func New(boardType BoardType) (*BoardFlasher, error)

func (*BoardFlasher) Flash

func (b *BoardFlasher) Flash(path string) error

func (*BoardFlasher) FlashAsync

func (b *BoardFlasher) FlashAsync(path string) error

type BoardType

type BoardType int
const (
	DfuBoard BoardType = iota
	TeensyBoard
)

type FlashState

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

func (*FlashState) CompletedSteps

func (s *FlashState) CompletedSteps() int

func (*FlashState) Finished

func (s *FlashState) Finished() bool

func (*FlashState) FlashError

func (s *FlashState) FlashError() error

func (*FlashState) Running

func (s *FlashState) Running() bool

func (*FlashState) TotalSteps

func (s *FlashState) TotalSteps() int

type FlashStep

type FlashStep int
const (
	Initializing FlashStep = iota
	InProgress
	Finished
)

Directories

Path Synopsis
cmd

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL