flipper

README

go-flipper

Control your Flipper Zero over Protobuf RPC protocol.

---

This library is designed to be transport agnostic, though I've tested it with RPC over VCP only.

The library is in a draft state. TODO:

• cover with godoc
• refactor the progressCallback crap
• better storage read/write implementation
• implement VCP transport out of the box
• set up proper git flow, CI, etc
• prepare a cool readme with some fashionable badges :>

Anna.

Documentation

Index

• Constants
• type File
• type Flipper
  • func Connect(rw io.ReadWriter) (*Flipper, error)
  • func ConnectWithTimeout(rw io.ReadWriter, timeout time.Duration) (*Flipper, error)
  • func (f *Flipper) StopSession() error
• type ScreenStreamFrame
  • func (sf ScreenStreamFrame) Bytes() []byte
  • func (sf ScreenStreamFrame) IsPixelSet(x, y int) bool
  • func (sf ScreenStreamFrame) ToImage(foreground, background color.Color) image.Image

Constants

const (
	InputKeyUp    = inputKey(pbgui.InputKey_UP)
	InputKeyDown  = inputKey(pbgui.InputKey_DOWN)
	InputKeyRight = inputKey(pbgui.InputKey_RIGHT)
	InputKeyLeft  = inputKey(pbgui.InputKey_LEFT)
	InputKeyOk    = inputKey(pbgui.InputKey_OK)
	InputKeyBack  = inputKey(pbgui.InputKey_BACK)
)

const (
	InputTypePress   = inputType(pbgui.InputType_PRESS)
	InputTypeRelease = inputType(pbgui.InputType_RELEASE)
	InputTypeShort   = inputType(pbgui.InputType_SHORT)
	InputTypeLong    = inputType(pbgui.InputType_LONG)
	InputTypeRepeat  = inputType(pbgui.InputType_REPEAT)
)

const (
	FileTypeFile = fileType(pbstorage.File_FILE)
	FileTypeDir  = fileType(pbstorage.File_DIR)
)

Types

type File

type File struct {
	Type fileType
	Name string
	Size uint32
	Data []byte
}

type Flipper

type Flipper struct {
	Status  status
	Storage storage
	App     app
	Gui     gui
	// contains filtered or unexported fields
}

func Connect

func Connect(rw io.ReadWriter) (*Flipper, error)

func ConnectWithTimeout

func ConnectWithTimeout(rw io.ReadWriter, timeout time.Duration) (*Flipper, error)

func (*Flipper) StopSession

func (f *Flipper) StopSession() error

type ScreenStreamFrame

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

func (ScreenStreamFrame) Bytes

func (sf ScreenStreamFrame) Bytes() []byte

func (ScreenStreamFrame) IsPixelSet

func (sf ScreenStreamFrame) IsPixelSet(x, y int) bool

func (ScreenStreamFrame) ToImage

func (sf ScreenStreamFrame) ToImage(foreground, background color.Color) image.Image