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 FileType
• 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 InputKey
• type InputType
• type RebootMode
• type ScreenFrame
  • func (sf ScreenFrame) Bytes() []byte
  • func (sf ScreenFrame) IsPixelSet(x, y int) bool
  • func (sf ScreenFrame) 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)
)

const (
	RebootModeOs  = RebootMode(pbsystem.RebootRequest_OS)
	RebootModeDfu = RebootMode(pbsystem.RebootRequest_DFU)
)

Types

type File

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

type FileType

type FileType pbstorage.File_FileType

type Flipper

type Flipper struct {
	System  system
	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 InputKey

type InputKey pbgui.InputKey

type InputType

type InputType pbgui.InputType

type RebootMode

type RebootMode pbsystem.RebootRequest_RebootMode

type ScreenFrame

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

func (ScreenFrame) Bytes

func (sf ScreenFrame) Bytes() []byte

func (ScreenFrame) IsPixelSet

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

func (ScreenFrame) ToImage

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